Copies an on-screen surface to a destination buffer. More...
#include <kanzi/gfx/commands.hpp>
Inheritance diagram for kanzi::gfx::CopySurfaceToBufferCommand:
Public Member Functions | |
| CopySurfaceToBufferCommand () | |
| Constructor. | |
 Public Member Functions inherited from kanzi::gfx::BaseCommand | |
| uint32_t | getSize () const |
| Gets the command size in bytes. | |
| uint8_t | getTag () const |
| Gets the command tag. | |
| CommandType | getType () const |
| Gets the command type. | |
| void | setTag (uint8_t tag) |
| Sets the command tag. | |
Public Attributes | |
| BufferHandleGuard | destinationBuffer |
| The destination buffer. | |
| uint32_t | destinationImageHeight |
| The destination height for 3D textures. Value 0 assumes the data is tightly packed according to source region. | |
| uint32_t | destinationOffset |
| The destination offset in bytes. | |
| uint32_t | destinationRowLength |
| The destination row length in pixels. Value 0 assumes the data is tightly packed according to source region. | |
| box3u32 | sourceRegion |
| The source region. | |
| FrameBufferHandleGuard | sourceSurface |
| The source frame buffer. This must be a frame buffer that represents an on-screen surface. | |
Additional Inherited Members | |
| Protected Member Functions inherited from kanzi::gfx::BaseCommand | |
| BaseCommand (CommandType t, uint32_t s) | |
| Constructor. | |
| BaseCommand (const BaseCommand &other) | |
| Copy Constructor. | |
| BaseCommand & | operator= (const BaseCommand &other) |
| Assignment operator. | |
Detailed Description
Copies an on-screen surface to a destination buffer.
- Since
- Kanzi 4.0.0
Constructor & Destructor Documentation
◆ CopySurfaceToBufferCommand()
|
inline |
Constructor.
Member Data Documentation
◆ sourceSurface
| FrameBufferHandleGuard kanzi::gfx::CopySurfaceToBufferCommand::sourceSurface |
The source frame buffer. This must be a frame buffer that represents an on-screen surface.
◆ sourceRegion
| box3u32 kanzi::gfx::CopySurfaceToBufferCommand::sourceRegion |
The source region.
◆ destinationBuffer
| BufferHandleGuard kanzi::gfx::CopySurfaceToBufferCommand::destinationBuffer |
The destination buffer.
◆ destinationOffset
| uint32_t kanzi::gfx::CopySurfaceToBufferCommand::destinationOffset |
The destination offset in bytes.
◆ destinationRowLength
| uint32_t kanzi::gfx::CopySurfaceToBufferCommand::destinationRowLength |
The destination row length in pixels. Value 0 assumes the data is tightly packed according to source region.
◆ destinationImageHeight
| uint32_t kanzi::gfx::CopySurfaceToBufferCommand::destinationImageHeight |
The destination height for 3D textures. Value 0 assumes the data is tightly packed according to source region.
The documentation for this struct was generated from the following file:
- kanzi/gfx/commands.hpp